Change Content Item's Description
{ changeItemDescription }
Sets the description for a given content item
Method
/API3/content/changeItemDescription
- Enterprise Admin
Input Parameters
Name
changeItemDescriptionData
Object Type
Description
The change object used to set a description for a given content item.
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Generic API response object with success or failure flag and related messages.
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/content/changeItemDescription" \
-d '{
"itemId" : "itemId",
"description" : "description"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ContentServiceApi;
import java.util.*;
import java.time.*;
public class ContentServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
ContentServiceApi apiInstance = new ContentServiceApi();
// Initialize the changeItemDescriptionData parameter object for the call
ChangeItemDescriptionData changeItemDescriptionData = ; // Create the input object for the operation, type: ChangeItemDescriptionData
try {
ModifiedItemsResult result = apiInstance.changeItemDescription(changeItemDescriptionData);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#changeItemDescription");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const changeItemDescriptionData = ; // {ChangeItemDescriptionData}
api.changeItemDescription(changeItemDescriptionData).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class changeItemDescriptionExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new ContentServiceApi();
// Initialize the changeItemDescriptionData parameter object for the call
var changeItemDescriptionData = new ChangeItemDescriptionData(); // ChangeItemDescriptionData |
try {
// Sets the description for a given content item
ModifiedItemsResult result = apiInstance.changeItemDescription(changeItemDescriptionData);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.changeItemDescription: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ContentServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = ContentServiceApi(api_client)
# Initialize the changeItemDescriptionData parameter object for the call
changeItemDescriptionData = # ChangeItemDescriptionData |
try:
# Sets the description for a given content item
api_response = api_instance.change_item_description(changeItemDescriptionData)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->changeItemDescription: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
$changeItemDescriptionData = ; // ChangeItemDescriptionData |
try {
$result = $api_instance->changeItemDescription($changeItemDescriptionData);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->changeItemDescription: ', $e->getMessage(), PHP_EOL;
}
?>